API Documentation
Public Member Functions | List of all members
nkInputs::MainSystem Class Referencefinal

Main interface with the component system. More...

Inheritance diagram for nkInputs::MainSystem:

Public Member Functions

InputSystemgetInputSystem () const
 
bool isInitialized () const
 
bool initialize ()
 
void shutdown ()
 

Detailed Description

Main interface with the component system.

Used to initialize or shuts all of its sub parts.

Member Function Documentation

◆ getInputSystem()

InputSystem* nkInputs::MainSystem::getInputSystem ( ) const
Returns
The input system.

◆ isInitialized()

bool nkInputs::MainSystem::isInitialized ( ) const
Returns
Whether the system is initialized (true) or not (false).

◆ initialize()

bool nkInputs::MainSystem::initialize ( )

Initializes the component and all of its sub part. This implies launching the input system and back end.

Returns
If the initialization was a success (true) or not (false).

◆ shutdown()

void nkInputs::MainSystem::shutdown ( )

Shuts down the component. This frees all memory linked to it and ensure a clean exit.


The documentation for this class was generated from the following file: